﻿//AcademicPlanner - course registration planning web app.
//Copyright (C) 2009  Boubacar Diallo

//This program is free software; you can redistribute it and/or
//modify it under the terms of the GNU General Public License
//as published by the Free Software Foundation; either version 2
//of the License, or (at your option) any later version.

//This program is distributed in the hope that it will be useful,
//but WITHOUT ANY WARRANTY; without even the implied warranty of
//MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//GNU General Public License for more details.

//You should have received a copy of the GNU General Public License
//along with this program; if not, write to the Free Software
//Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.


using System;
using AcademicPlanner.Data.Repositories;

namespace AcademicPlanner.Data.Entities
{
	/// <summary>
	/// AccountEntity represents the data aspect of a domain layer's <c>Account</c>.
	/// </summary>
	/// <since>1.0</since>
	public class AccountEntity : Entity
    {
		/// <summary>
		/// Gets or sets when this AccountEntity was activated.
		/// </summary>
		/// <since>1.0</since>
		public virtual DateTime ? Date_Inactivated { get; set; }

		/// <summary>
		/// Gets or sets when this AccountEntity was inactivated.
		/// </summary>
		/// <since>1.0</since>
		public virtual DateTime ? Date_Activated { get; set; }

		/// <summary>
		/// Gets or sets whether this AccountEntity is activated or not.
		/// </summary>
		/// <since>1.0</since>
		public virtual bool Activated { get; set; }

		/// <summary>
		/// Gets or sets this AccountEntity's <c>UserEntity</c>.
		/// </summary>
		/// <since>1.0</since>
		public virtual UserEntity UserEntity { get; set; }

		/// <summary>
		/// Gets or sets the <c>PersonEntity</c> this AccountEntity belongs to.
		/// </summary>
		/// <since>1.0</since>
		public virtual PersonEntity PersonEntity { get; set; }


		/// <summary>
		/// Sets the default values of this <c>AccountEntity</c>'s properties.
		/// <c>Activated</c> is set to <c>false</c>, <c>Date_Activated</c> is set to <c>null</c>,
		/// <c>Date_Inactivated</c> is set to <c>null</c> and <c>UserEntity</c>
		/// is set to a new <c>UserEntity</c>.
		/// </summary>
		/// <seealso cref="M:AcademicPlanner.Data.Entity.SetDefaults"/>
		/// <seealso cref="M:AcademicPlanner.Data.Repositories.UserEntityRepository.GetNew"/>
		/// <version>1.0</version>
		/// <since>1.0</since>
		public override void SetDefaults()
		{
			base.SetDefaults();
			Activated = false;
			Date_Activated = null;
			Date_Inactivated = null;
			UserEntity = DSAS.UserEntityRepo.GetNew();
		}
    }
}
